object endpoint to find internal links for resources #145

recalcitrantsupplant · 2023-08-09T12:57:00Z

From dev readme:
High Level Sequence /object endpoint

Prez provides a /object endpoint as an endpoint that supplies any information known about a given URI. If an annotated
mediatype is requested, prez will additionally provide all system links for endpoints which can render the object. The
high level sequence for this endpoint is as follows:

Get the URI for the object from the query string
Get the class(es) of the object from the triplestore
Use prez's reference data for endpoints to determine which endpoints can render this object, and, a template for
these endpoints, specifying any variables that need to be substituted (such as parent URIs).
Get the object information from the triplestore, using an open profile, and in parallel any system information needed
to construct the system links.
Return the response

The same functions that are used to do the above have been generally applied to annotated responses. Any annotated response from prez will now:

Find any URIs in the initial response from the triplestore
Find the classes for these URIs
Use the (new) prez endpoints graph (reference_data/endpoints/) to find endpoints that can deliver the class(es), and, get a template for these endpoints, specifying any variables that need to be substituted (such as parent URIs).
Go back to the triplestore to populate the endpoint templates.
Return the original response + prez:links

Other minor changes:

Add endpoint reference data to support system link generation (reference_data/endpoints)
Rename inbound/outbound children/parents to focus to/from child/parent terminology to align with SHACL. Rename general_class to base_class. Resolves Rename general_class to item_class #101
Add a triple: of the form: ~~<focus_uri> prez:endpointComponentURI <uri_used_in_endpoint>~~ <endpoint_component_uri> dcterms:identifier "{curie_id}"^^prez:identifier for parent CURIEs in endpoints such that the URIs of parents are included in the response, and get annotated, such that labels are available for breadcrumbs.

Add endpoint reference data to support system link generation. Rename inbound/outbound children/parents to focus to/from child/parent terminology to align with SHACL. Rename general_class to base_class. Resolves #101

Remove commented code.

Remove commented code. Fix object tests.

Add endpoint reference data to support system link generation. Rename inbound/outbound children/parents to focus to/from child/parent terminology to align with SHACL. Rename general_class to base_class. Resolves #101

Remove commented code.

Remove commented code. Fix object tests.

…eterministic way on startup and we shouldn't rely on them being deterministic in tests. Both ns1 & ns2 come back in responses for the same link (for a given URI) if the test is run multiple times. Workaround implemented. The test is not intended to test link generation or prefix generation.

…URIs of parents are included in the response, and get annotated, such that labels are available for breadcrumbs. Update spaceprez profile to include dcterms:title for the OAS profile.

Add setting to make ordering optional via ORDER_LISTS_BY_LABEL environment variable, which is on by default.

jamiefeiss

Tested locally, the /profiles endpoint doesn't return prez:links

edmondchuc · 2023-08-24T07:05:54Z

Can confirm. I have the same issue as @jamiefeiss.

recalcitrantsupplant · 2023-08-24T07:39:26Z

I have a fix coming, should be tomorrow.

Add vann prefixes; correct prefix format

jamiefeiss

After some local testing, I've found two issues:

For a skos:Concept page, the prez:endpointComponentURI triple seems to be missing:

aarr:chair a skos:Concept ;
    dcterms:identifier "aarr:chair"^^prez1:identifier ;
    dcterms:provenance "Developed for this Agent to Agent Roles vocabulary"@en ;
    rdfs:isDefinedBy <https://data.idnau.org/pid/vocab/aarr> ;
    skos:broader aarr:member ;
    skos:definition "The presiding officer of an assembly, meeting, committee, or board"@en ;
    skos:inScheme <https://data.idnau.org/pid/vocab/aarr> ;
    skos:prefLabel "Chair"@en ;
    skos:scopeNote "Organisation to Person relations" ;
    prez1:link "/v/vocab/vcb:aarr/aarr:chair" .

For a skos:Collection page, a server error occurs: AttributeError: 'list' object has no attribute 'name', which points to this line:

prez/prez/services/generate_profiles.py

Line 90 in 4d5a0ba

response = profiles_graph_cache.query(query)

where the problem seems to be a missing class in the SPARQL query:

VALUES ?class {}

recalcitrantsupplant · 2023-08-28T08:26:38Z

Thanks Jamie I'll take a look.

…

On Mon, 28 Aug 2023, 17:41 Jamie Feiss, ***@***.***> wrote: ***@***.**** requested changes on this pull request. After some local testing, I've found two issues: 1. For a skos:Concept page, the prez:endpointComponentURI triple seems to be missing: aarr:chair a skos:Concept ; dcterms:identifier "aarr:chair"^^prez1:identifier ; dcterms:provenance "Developed for this Agent to Agent Roles ***@***.*** ; rdfs:isDefinedBy <https://data.idnau.org/pid/vocab/aarr> ; skos:broader aarr:member ; skos:definition "The presiding officer of an assembly, meeting, committee, or ***@***.*** ; skos:inScheme <https://data.idnau.org/pid/vocab/aarr> ; skos:prefLabel ***@***.*** ; skos:scopeNote "Organisation to Person relations" ; prez1:link "/v/vocab/vcb:aarr/aarr:chair" . 1. For a skos:Collection page, a server error occurs: AttributeError: 'list' object has no attribute 'name', which points to this line: https://github.com/RDFLib/prez/blob/4d5a0ba0bdcae67323d2373fed655c2aa05e6697/prez/services/generate_profiles.py#L90 where the problem seems to be a missing class in the SPARQL query: VALUES ?class {} — Reply to this email directly, view it on GitHub <#145 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACQUSNXFSDPJY7PKTRKH4A3XXRDTVANCNFSM6AAAAAA3J63ICA> . You are receiving this because you authored the thread.Message ID: ***@***.***>

…prez:identifier for providing parent information that can be used in breadcrumbs. Update tests accordingly. Bugfix: Add endpoint name so vocprez endpoint functions correctly.

recalcitrantsupplant · 2023-08-29T07:21:53Z

@jamiefeiss both fixed now - note I've switched to the dcterms:identifier to include parent URL components / their labels. From the updated notes:

Add a triple: of the form: <endpoint_component_uri> dcterms:identifier "{curie_id}"^^prez:identifier for parent CURIEs in endpoints such that the URIs of parents are included in the response, and get annotated, such that labels are available for breadcrumbs.

prez/cache.py

cheers Co-authored-by: Edmond Chuc <37032744+edmondchuc@users.noreply.github.com>

jamiefeiss

The frontend has everything it needs now after local testing. Thanks David

recalcitrantsupplant · 2023-08-30T09:47:45Z

@edmondchuc I think I've addressed the feedback (just the single suggested change) let me know if I've missed something otherwise will merge

jamiefeiss

I found another issue I must've overlooked before: search results are missing labels and geometries. See the screenshot below, the map with geometries should be displaying on the right:

recalcitrantsupplant · 2023-08-31T07:59:53Z

thanks Jamie, not sure if these changes caused that issue, in any case I'd like to merge this in before this PR gets any larger. Could you raise an issue separately? I'll address it when making the filter addition to search.

recalcitrantsupplant added 13 commits June 25, 2023 22:46

Object endpoint returns system links.

7a592ea

Add endpoint reference data to support system link generation. Rename inbound/outbound children/parents to focus to/from child/parent terminology to align with SHACL. Rename general_class to base_class. Resolves #101

Update documentation.

aa61e61

Remove commented code.

Update documentation.

e493bdd

Remove commented code. Fix object tests.

Object endpoint returns system links.

6f19d4e

Add endpoint reference data to support system link generation. Rename inbound/outbound children/parents to focus to/from child/parent terminology to align with SHACL. Rename general_class to base_class. Resolves #101

Update documentation.

554352f

Remove commented code.

Update documentation.

c61ca27

Remove commented code. Fix object tests.

Minimal tests working

bd93347

Roll out link generation across catprez / vocprez / spaceprez

934b174

Bugfix for profiles test

31383e9

Add prez:endpointComponentURI for parents in endpoints such that the …

d01e9df

…URIs of parents are included in the response, and get annotated, such that labels are available for breadcrumbs. Update spaceprez profile to include dcterms:title for the OAS profile.

Add TODOs.

578c272

Add setting to make ordering optional via ORDER_LISTS_BY_LABEL environment variable, which is on by default.

Update tests to include endpointComponentURIs

aa082b5

recalcitrantsupplant marked this pull request as ready for review August 22, 2023 11:42

recalcitrantsupplant requested review from nicholascar, edmondchuc, jamiefeiss and hjohns and removed request for nicholascar and edmondchuc August 22, 2023 11:42

jamiefeiss requested changes Aug 23, 2023

View reviewed changes

recalcitrantsupplant added 2 commits August 25, 2023 17:52

Update profiles endpoints to include prez links

ab067f3

Add vann prefixes; correct prefix format

Remove inadvertently added OGC content

4d5a0ba

jamiefeiss requested changes Aug 28, 2023

View reviewed changes

Change use of prez:endpointComponentURI -> dcterms:identifier "abc"^^…

f144613

…prez:identifier for providing parent information that can be used in breadcrumbs. Update tests accordingly. Bugfix: Add endpoint name so vocprez endpoint functions correctly.

Fix bug with identifiers not being included for concepts

3fba851

edmondchuc requested changes Aug 30, 2023

View reviewed changes

prez/cache.py Outdated Show resolved Hide resolved

recalcitrantsupplant and others added 2 commits August 30, 2023 15:53

Update test responses, comment one test. One bugfix to get_classes

a719592

Update prez/cache.py

3e5927d

cheers Co-authored-by: Edmond Chuc <37032744+edmondchuc@users.noreply.github.com>

jamiefeiss self-requested a review August 30, 2023 07:15

jamiefeiss approved these changes Aug 30, 2023

View reviewed changes

edmondchuc approved these changes Aug 30, 2023

View reviewed changes

jamiefeiss requested changes Aug 31, 2023

View reviewed changes

recalcitrantsupplant closed this Aug 31, 2023

recalcitrantsupplant reopened this Aug 31, 2023

recalcitrantsupplant merged commit df00e01 into main Aug 31, 2023
1 check passed

recalcitrantsupplant deleted the david/object-endpoint branch June 6, 2024 11:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

object endpoint to find internal links for resources #145

object endpoint to find internal links for resources #145

recalcitrantsupplant commented Aug 9, 2023 •

edited

Loading

jamiefeiss left a comment

edmondchuc commented Aug 24, 2023

recalcitrantsupplant commented Aug 24, 2023

jamiefeiss left a comment

recalcitrantsupplant commented Aug 28, 2023 via email

recalcitrantsupplant commented Aug 29, 2023

jamiefeiss left a comment

recalcitrantsupplant commented Aug 30, 2023

jamiefeiss left a comment

recalcitrantsupplant commented Aug 31, 2023

object endpoint to find internal links for resources #145

object endpoint to find internal links for resources #145

Conversation

recalcitrantsupplant commented Aug 9, 2023 • edited Loading

jamiefeiss left a comment

Choose a reason for hiding this comment

edmondchuc commented Aug 24, 2023

recalcitrantsupplant commented Aug 24, 2023

jamiefeiss left a comment

Choose a reason for hiding this comment

recalcitrantsupplant commented Aug 28, 2023 via email

recalcitrantsupplant commented Aug 29, 2023

jamiefeiss left a comment

Choose a reason for hiding this comment

recalcitrantsupplant commented Aug 30, 2023

jamiefeiss left a comment

Choose a reason for hiding this comment

recalcitrantsupplant commented Aug 31, 2023

recalcitrantsupplant commented Aug 9, 2023 •

edited

Loading